/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.wsinfra.util;

import javax.xml.namespace.QName;

import org.apache.xmlbeans.XmlCursor;
import org.apache.xmlbeans.XmlObject;

import cgl.narada.wsinfra.schemas.addressing.ActionDocument;
import cgl.narada.wsinfra.schemas.addressing.EndpointReferenceType;
import cgl.narada.wsinfra.schemas.soap.BodyType;
import cgl.narada.wsinfra.schemas.soap.Detail;
import cgl.narada.wsinfra.schemas.soap.EnvelopeDocument;
import cgl.narada.wsinfra.schemas.soap.EnvelopeType;
import cgl.narada.wsinfra.schemas.soap.FaultDocument;
import cgl.narada.wsinfra.schemas.soap.FaultType;
import cgl.narada.wsinfra.schemas.soap.HeaderType;
import cgl.narada.wsinfra.wsa.WsaActions;
import cgl.narada.wsinfra.wsa.WsaEprRules;
import cgl.narada.wsinfra.wsa.WsaProcessingFactory;

/** This class enables the creation of faults. Note that currently this class
    creates on SOAP 1.1 faults, it should be no big deal to have a similar
    capability for SOAP 1.2. If a need arises one will be provided.

    @author Shrideep Pallickara
    $Date: 2005/07/29 22:41:29 $
    $Revision: 1.8 $
*/


public class FaultCreator {

  private static final FaultCreator instance = new FaultCreator();
  private WsaActions wsaActions;
  private WsaEprRules wsaEprRules;
  private String moduleName = "FaultCreator: ";


  private FaultCreator() {
    wsaEprRules = WsaProcessingFactory.getWsaEprRules();
    wsaActions = WsaProcessingFactory.getWsaActions();
  }


  /** Get an instance of the FaultCreator */
  public static FaultCreator getInstance() {
    return instance;
  }


  public EnvelopeDocument
  createFault(QName faultCodeQName, String reason,
	      EndpointReferenceType faultTo) {

    EnvelopeDocument envelopeDocument =getInitializedEnvelopeDocument(faultTo);
    FaultDocument faultDocument = getFaultDocument(faultCodeQName, reason);
    copyFaultIntoSOAPBody(envelopeDocument, faultDocument);

    return envelopeDocument;
  }


  public EnvelopeDocument
  createFault(QName faultCodeQName, String reason,  XmlObject detailObject,
	      EndpointReferenceType faultTo) {

    EnvelopeDocument envelopeDocument =getInitializedEnvelopeDocument(faultTo);
    FaultDocument faultDoc = getFaultDocument(faultCodeQName, reason);

    FaultType fault = faultDoc.getFault();
    processFaultDetailElement(fault, detailObject);

    copyFaultIntoSOAPBody(envelopeDocument, faultDoc);

    return envelopeDocument;
  } /* end create fault */


  public EnvelopeDocument
  createFault(QName faultCodeQName, String reason,  String faultActor,
	      EndpointReferenceType faultTo) {

    EnvelopeDocument envelopeDocument =getInitializedEnvelopeDocument(faultTo);
    FaultDocument faultDoc = getFaultDocument(faultCodeQName, reason);

    FaultType fault = faultDoc.getFault();

    if (faultActor != null) {
      fault.setFaultactor(faultActor);
    }
    copyFaultIntoSOAPBody(envelopeDocument, faultDoc);

    return envelopeDocument;
  } /* end create fault */


  public EnvelopeDocument
  createFault(QName faultCodeQName, String reason,
	      XmlObject detailObject, String faultActor,
	      EndpointReferenceType faultTo) {

    EnvelopeDocument envelopeDocument =getInitializedEnvelopeDocument(faultTo);
    FaultDocument faultDoc = getFaultDocument(faultCodeQName, reason);

    FaultType fault = faultDoc.getFault();

    if (faultActor != null) {
      fault.setFaultactor(faultActor);
    }

    processFaultDetailElement(fault, detailObject);

    copyFaultIntoSOAPBody(envelopeDocument, faultDoc);

    return envelopeDocument;
  } /* end create fault */




  /** This method returns an envelope with the header initialized to
      indicate that the body contains a Fault Message */
  private EnvelopeDocument
  getInitializedEnvelopeDocument(EndpointReferenceType faultTo) {

    EnvelopeDocument envelopeDocument =
      wsaEprRules.prepareSOAPEnvelope(faultTo);

    EnvelopeType envelope = envelopeDocument.getEnvelope();

    /** First prepare the header of the SOAP envelope to contain the
	action Attribute value */
    BodyType body = envelope.getBody();
    HeaderType header = envelope.getHeader();
    XmlCursor headerCursor = header.newCursor();

    /** Add the Ws-Addressing action element to the SOAP Header element */
    ActionDocument actionDoc = ActionDocument.Factory.newInstance();
    actionDoc.addNewAction().setStringValue(wsaActions.getFault() );

    XmlCursor actionCursor = actionDoc.newCursor();

    /** Copy the contents of the action cursor into the SOAP header element */
    headerCursor.toNextToken(); //first position cursor to the right location.
    actionCursor.copyXmlContents(headerCursor);

    headerCursor.dispose();
    actionCursor.dispose();

    return envelopeDocument;
  }




  /** Initializes a fault document and returns it */
  public FaultDocument getFaultDocument(QName faultCodeQName, String reason) {

    FaultDocument faultDoc = FaultDocument.Factory.newInstance();
    FaultType fault = faultDoc.addNewFault();

    fault.setFaultcode(faultCodeQName);
    fault.setFaultstring(reason);

    return faultDoc;
  }



  /** Copies the content of the Fault element into the SOAP Body */
  public void copyFaultIntoSOAPBody(EnvelopeDocument envelopeDocument,
				     FaultDocument faultDocument) {
    BodyType body = envelopeDocument.getEnvelope().getBody();
    XmlCursor bodyCursor = body.newCursor();

    /** Proceed to add the newly created/initialized fault to the body of the
	SOAP message */
    XmlCursor faultCursor = faultDocument.newCursor();
    bodyCursor.toNextToken();
    faultCursor.copyXmlContents(bodyCursor);

    faultCursor.dispose();
    bodyCursor.dispose();
  }


  /** Copy the contents of the XmlObject into the Fault element inside the
      Detail element */
  private void
  processFaultDetailElement(FaultType fault, XmlObject detailObject) {

    if (detailObject != null) {
      Detail detail = fault.addNewDetail();
      XmlCursor detailObjectCursor = detailObject.newCursor();
      XmlCursor detailCursor = detail.newCursor();
      detailCursor.toNextToken();
      detailObjectCursor.copyXmlContents(detailCursor);
      detailCursor.dispose();
      detailObjectCursor.dispose();
    }
  }

}

